/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wse;

import cgl.narada.wsinfra.exception.MessageFlowException;
import cgl.narada.wsinfra.exception.WsFaultException;
import cgl.narada.wsinfra.schemas.eventing.GetStatusDocument;
import cgl.narada.wsinfra.schemas.eventing.GetStatusResponseDocument;
import cgl.narada.wsinfra.schemas.eventing.RenewDocument;
import cgl.narada.wsinfra.schemas.eventing.RenewResponseDocument;
import cgl.narada.wsinfra.schemas.eventing.UnsubscribeDocument;
import cgl.narada.wsinfra.schemas.soap.EnvelopeDocument;
import cgl.narada.wsinfra.wsa.AddressingHeaders;


/** This interface encapsulates the behavior of a WS-Eventing
    subscription manager node.

    @author Shrideep Pallickara
    $Date: 2005/07/29 22:41:30 $
    $Revision: 1.5 $
*/

public interface WseSubscriptionManager {

  /** This method is used to notify a subscription manager of the a
      successuful subscription request-response combination.
      The request (issued by the sink) allows a subscription manager to know
      about the subscription, while the response (issued by the source) allows
      it know the wse:Identifer for this subscription and also the expiry
      associated with the subscription. Also note that the wse:Identifier is
      what is used by the sinks in all their interactions with the subscription
      manager */
  public void processSubscriptionAddition(EnvelopeDocument envelopeDocument,
					 AddressingHeaders addressingHeaders)
    throws WsFaultException, MessageFlowException;


  /** Process the a GetStatus request issued by a sink. A fault may be thrown
      if there are problems processing this request.
      wse:Identifer is needed.
  */
  public GetStatusResponseDocument
  processGetStatusOfSubscription(GetStatusDocument getStatusDocument )
    throws WsFaultException;



  /** Process a renew request issued by a sink. A fault may be thrown
      if there are problems processing this request.
      wse:Identifier is needed */
  public RenewResponseDocument
  processRenewSubscription(RenewDocument renewDocument)
    throws WsFaultException;



  /** Process an unsubscribe request issued by a sink. A fault may be thrown
      if there are problems processing this request.
      wse:Identifier is needed */
  public EnvelopeDocument
  processUnsubscribe(UnsubscribeDocument unsubscribeDocument)
    throws WsFaultException;

}
